<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Algorithm/IpSearchDirCalculator.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.12</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('IpSearchDirCalculator_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">IpSearchDirCalculator.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="IpSearchDirCalculator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// Copyright (C) 2005, 2007 International Business Machines and others.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// Authors:  Andreas Waechter            IBM    2005-10-13</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifndef __IPSEARCHDIRCALCULATOR_HPP__</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#define __IPSEARCHDIRCALCULATOR_HPP__</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a>&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;{</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html">   18</a></span>&#160;<span class="keyword">class </span><a class="code" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html">SearchDirectionCalculator</a>: <span class="keyword">public</span> <a class="code" href="classIpopt_1_1AlgorithmStrategyObject.html">AlgorithmStrategyObject</a></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html#a438eda9e044a9e785aa22b68b02e66cf">   24</a></span>&#160;   <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html#a438eda9e044a9e785aa22b68b02e66cf">SearchDirectionCalculator</a>()</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;   { }</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html#a515d7a55384e2294bdd50d00211fd942">   28</a></span>&#160;   <span class="keyword">virtual</span> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html#a515d7a55384e2294bdd50d00211fd942">~SearchDirectionCalculator</a>()</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;   { }</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html#a5dae9d951413f50cccffc0d9d4e54238">   32</a></span>&#160;   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html#a5dae9d951413f50cccffc0d9d4e54238">InitializeImpl</a>(</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1OptionsList.html">OptionsList</a>&amp; options,</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;      <span class="keyword">const</span> std::string&amp; prefix</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;   ) = 0;</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html#a00ea6658aa464bbe62c1dd0b3834e882">   41</a></span>&#160;   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html#a00ea6658aa464bbe62c1dd0b3834e882">ComputeSearchDirection</a>() = 0;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;   <span class="comment">//    SearchDirectionCalculator();</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html#ab742295ce0c8efa884e31311fc917408">   58</a></span>&#160;   <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html#ab742295ce0c8efa884e31311fc917408">SearchDirectionCalculator</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html">SearchDirectionCalculator</a>&amp;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;   );</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classIpopt_1_1SearchDirectionCalculator.html#a047fa71c99974e7545d471306324204a">   63</a></span>&#160;   <span class="keywordtype">void</span> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html#a047fa71c99974e7545d471306324204a">operator=</a>(</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SearchDirectionCalculator.html">SearchDirectionCalculator</a>&amp;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;   );</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;};</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;} <span class="comment">// namespace Ipopt</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html_a047fa71c99974e7545d471306324204a"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html#a047fa71c99974e7545d471306324204a">Ipopt::SearchDirectionCalculator::operator=</a></div><div class="ttdeci">void operator=(const SearchDirectionCalculator &amp;)</div><div class="ttdoc">Default Assignment Operator.</div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition:</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html_a00ea6658aa464bbe62c1dd0b3834e882"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html#a00ea6658aa464bbe62c1dd0b3834e882">Ipopt::SearchDirectionCalculator::ComputeSearchDirection</a></div><div class="ttdeci">virtual bool ComputeSearchDirection()=0</div><div class="ttdoc">Pure virtual method for computing the search direction.</div></div>
<div class="ttc" id="aconfig__default_8h_html_a58bb5c104ee5ff44b7175fc992d89b0b"><div class="ttname"><a href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a></div><div class="ttdeci">#define IPOPTLIB_EXPORT</div><div class="ttdef"><b>Definition:</b> <a href="config__default_8h_source.html#l00011">config_default.h:10</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html">Ipopt::SearchDirectionCalculator</a></div><div class="ttdoc">Base class for computing the search direction for the line search.</div><div class="ttdef"><b>Definition:</b> <a href="IpSearchDirCalculator_8hpp_source.html#l00018">IpSearchDirCalculator.hpp:19</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html_a515d7a55384e2294bdd50d00211fd942"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html#a515d7a55384e2294bdd50d00211fd942">Ipopt::SearchDirectionCalculator::~SearchDirectionCalculator</a></div><div class="ttdeci">virtual ~SearchDirectionCalculator()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="IpSearchDirCalculator_8hpp_source.html#l00028">IpSearchDirCalculator.hpp:28</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html_ab742295ce0c8efa884e31311fc917408"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html#ab742295ce0c8efa884e31311fc917408">Ipopt::SearchDirectionCalculator::SearchDirectionCalculator</a></div><div class="ttdeci">SearchDirectionCalculator(const SearchDirectionCalculator &amp;)</div><div class="ttdoc">Default Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html_a438eda9e044a9e785aa22b68b02e66cf"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html#a438eda9e044a9e785aa22b68b02e66cf">Ipopt::SearchDirectionCalculator::SearchDirectionCalculator</a></div><div class="ttdeci">SearchDirectionCalculator()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> <a href="IpSearchDirCalculator_8hpp_source.html#l00024">IpSearchDirCalculator.hpp:24</a></div></div>
<div class="ttc" id="aclassIpopt_1_1AlgorithmStrategyObject_html"><div class="ttname"><a href="classIpopt_1_1AlgorithmStrategyObject.html">Ipopt::AlgorithmStrategyObject</a></div><div class="ttdoc">This is the base class for all algorithm strategy objects.</div><div class="ttdef"><b>Definition:</b> <a href="IpAlgStrategy_8hpp_source.html#l00034">IpAlgStrategy.hpp:35</a></div></div>
<div class="ttc" id="aIpAlgStrategy_8hpp_html"><div class="ttname"><a href="IpAlgStrategy_8hpp.html">IpAlgStrategy.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1OptionsList_html"><div class="ttname"><a href="classIpopt_1_1OptionsList.html">Ipopt::OptionsList</a></div><div class="ttdoc">This class stores a list of user set options.</div><div class="ttdef"><b>Definition:</b> <a href="IpOptionsList_8hpp_source.html#l00032">IpOptionsList.hpp:33</a></div></div>
<div class="ttc" id="aclassIpopt_1_1SearchDirectionCalculator_html_a5dae9d951413f50cccffc0d9d4e54238"><div class="ttname"><a href="classIpopt_1_1SearchDirectionCalculator.html#a5dae9d951413f50cccffc0d9d4e54238">Ipopt::SearchDirectionCalculator::InitializeImpl</a></div><div class="ttdeci">virtual bool InitializeImpl(const OptionsList &amp;options, const std::string &amp;prefix)=0</div><div class="ttdoc">Implementation of the initialization method that has to be overloaded by for each derived class.</div></div>
</body>
</html>
